Skip to main content

ChargeBee

Adding ChargeBee as data source​

Prequisites for adding Chargebee

The following connector information is required from the client:

  • API key

  • Site

  • Start date

Do the following to

  1. Log on to your Chargebee account.

  2. To create and configure the API keys, select Settings > Configure Chargebee > API Keys and Webhooks.

  3. Click on the API Keys tab. Any existing API keys are listed.

    Chargebee

To add ChargeBee as a data source, do the following:

  1. From the left navigation panel, click Lakehouse and then click Data Sources.

  2. From the upper right corner of the page, click the + New Database button to start the process of adding a new database.

  3. In the New Data Source page, click the Chargebee icon.

  4. Specify the following details to add Chargebee. Once you have connected a data source, the system immediately fetches its schema. After this schema retrieval process is complete you can browse and interact with the tables and data.

    Add_Chargebee
    FieldDescription
    Connection NameEnter a unique name for the connection.
    API KeyEnter the ChargeBee API Key.
    SiteThe site prefix for your ChargeBee instance.
    Start DateEnter the date in the MM-DD-YYYY format. DataGOL will replicate the data updated on and after this date.

  5. Click Submit.

Supported sync modes​

The Chargebee source connector supports the following Sync modes:

  • Full Refresh |Overwrite
  • Full Refresh | Append
  • Incremental | Append
  • Incremental | Append + Deduped

Supported streams​

The Chargebee source connector supports the following streams:

  • Addons

  • Attached Items

  • Comments

  • Contacts

  • Coupons

  • Credit Notes

  • Customers

  • Differential Prices

  • Events

  • Gifts

  • Hosted Pages

  • Invoices

  • Items

  • Item Prices

  • Item Families

  • Orders

  • Payment Sources

  • Plans

  • Promotional Credits

  • Quotes

  • Quote Line Groups

  • Site Migration Details

  • Subscriptions

  • Subscriptions With Scheduled Changes

  • Transactions

  • Unbilled Charges

  • Virtual Bank Accounts